<!DOCTYPE html>
<html>
  <head>
  <meta charset='UTF-8'>
  <title>CamanJS Documentation</title>
  <link rel='stylesheet' href='../../assets/codo.css' type='text/css'>
  <script src='../../assets/codo.js'></script>
  <script src='../../assets/search_data.js'></script>
</head>
  <body>
    <div id='base' data-path='../../'></div>
<div id='header'>
  <div id='menu'>
    <a href='../../README.md.html' title='CamanJS'>CamanJS</a>
    &raquo;
    <a href='../../class_index.html' title='Index'>Index</a>
    &raquo;
    <a href='../../classes/Caman.html' title='Caman'>Caman</a>
    &raquo;
    <span class='title'>Event</span>
    <nav>
      <ul>
        <li class='noframes'>
          (<a class='noframes' href='#'>no frames</a>)
        </li>
      </ul>
    </nav>
    <div id='search'>
      <a id='class_list_link' href='../../class_list.html'>Classes</a>
      <a id='file_list_link' href='../../file_list.html'>Files</a>
      <a id='method_list_link' href='../../method_list.html'>Methods</a>
      <a id='extra_list_link' href='../../extra_list.html'>Extras</a>
    </div>
  </div>
  <iframe id='search_frame'></iframe>
  <div id='fuzzySearch'>
    <input type='text'>
    <ol></ol>
  </div>
  <div id='help'>
    <p>
      Quickly fuzzy find classes, mixins, methods, file:
    </p>
    <ul>
      <li>
        <span>Ctrl-T</span>
        Open fuzzy finder dialog
      </li>
    </ul>
    <p>
      In frame mode you can toggle the list naviation frame on the left side:
    </p>
    <ul>
      <li>
        <span>Ctrl-L</span>
        Toggle list view
      </li>
    </ul>
    <p>
      You can focus a list in frame mode or toggle a tab in frameless mode:
    </p>
    <ul>
      <li>
        <span>Ctrl-C</span>
        Class list
      </li>
      <li>
        <span>Ctrl-I</span>
        Mixin list
      </li>
      <li>
        <span>Ctrl-F</span>
        File list
      </li>
      <li>
        <span>Ctrl-M</span>
        Method list
      </li>
      <li>
        <span>Ctrl-E</span>
        Extras list
      </li>
    </ul>
    <p>
      You can focus and blur the search input:
    </p>
    <ul>
      <li>
        <span>Ctrl-S</span>
        Focus search input
      </li>
      <li>
        <span>Esc</span>
        Blur search input
      </li>
    </ul>
    <p>
      In frameless mode you can close the list tab:
    </p>
    <ul>
      <li>
        <span>Esc</span>
        Close list tab
      </li>
    </ul>
  </div>
</div>
    <div id='content'>
      <h1>
        Class:
        Caman.Event
      </h1>
      <table class='box'>
        <tr>
          <td>Defined in:</td>
          <td>src&#47;core&#47;event.coffee</td>
        </tr>
      </table>
      <h2>Overview</h2>
      <div class='docstring'>
  <p>Event system that can be used to register callbacks that get fired
during certain times in the render process.</p>
</div>
<div class='tags'>
</div>
      <h2>Class Method Summary</h2>
      <ul class='summary'>
  <li>
    <span class='signature'>
      <a href='#trigger-class'>
        + (void) <strong>trigger</strong>(target, type, data = null)
      </a>
    </span>
    <span class='desc'>
      Trigger an event.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='#listen-class'>
        + (void) <strong>listen</strong>(target, type, fn)
      </a>
    </span>
    <span class='desc'>
      Listen for an event.
    </span>
  </li>
</ul>
      <h2>Class Method Details</h2>
      <div class='methods'>
  <div class='method_details'>
    <p class='signature' id='trigger-class'>
      + (void) <strong>trigger</strong>(target, type, data = null)
    </p>
    <div class='docstring'>
  <p>Trigger an event.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='name'>target</span>
      <span class='type'>
        (<tt><a href='../../classes/Caman.html'>Caman</a></tt>)
      </span>
      &mdash;
      <span class='desc'>Instance of Caman emitting the event.</span>
    </li>
    <li>
      <span class='name'>type</span>
      <span class='type'>
        (<tt>String</tt>)
      </span>
      &mdash;
      <span class='desc'>The event type.</span>
    </li>
    <li>
      <span class='name'>data</span>
      <span class='type'>
        (<tt>Object</tt>)
      </span>
      &mdash;
      <span class='desc'>Extra data to send with the event.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='listen-class'>
      + (void) <strong>listen</strong>(target, type, fn)
      <br>
      + (void) <strong>listen</strong>(type, fn)
      <br>
    </p>
    <div class='docstring'>
  <p>Listen for an event. Optionally bind the listen to a single instance
or all instances.</p>
</div>
<div class='tags'>
  <div class='overloads'>
    <h3>Overloads:</h3>
    <div class='overload'>
      <p class='signature'>
        + (void) <strong>listen</strong>(target, type, fn)
      </p>
      <div class='docstring'>
  <p>Listen for events emitted from a particular Caman instance.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='name'>target</span>
      <span class='type'>
        (<tt><a href='../../classes/Caman.html'>Caman</a></tt>)
      </span>
      &mdash;
      <span class='desc'>The instance to listen to.</span>
    </li>
    <li>
      <span class='name'>type</span>
      <span class='type'>
        (<tt>String</tt>)
      </span>
      &mdash;
      <span class='desc'>The type of event to listen for.</span>
    </li>
    <li>
      <span class='name'>fn</span>
      <span class='type'>
        (<tt>Function</tt>)
      </span>
      &mdash;
      <span class='desc'>The function to call when the event occurs.</span>
    </li>
  </ul>
</div>
    </div>
    <div class='overload'>
      <p class='signature'>
        + (void) <strong>listen</strong>(type, fn)
      </p>
      <div class='docstring'>
  <p>Listen for an event from all Caman instances.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='name'>type</span>
      <span class='type'>
        (<tt>String</tt>)
      </span>
      &mdash;
      <span class='desc'>The type of event to listen for.</span>
    </li>
    <li>
      <span class='name'>fn</span>
      <span class='type'>
        (<tt>Function</tt>)
      </span>
      &mdash;
      <span class='desc'>The function to call when the event occurs.</span>
    </li>
  </ul>
</div>
    </div>
  </div>
</div>
  </div>
</div>
    </div>
    <div id='footer'>
  Generated on
  Wed Nov 13 2013 09:33:09 GMT-0500 (EST)
  by
  <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
  v1.7.0
  (Node.js v0.10.21).
  &#10034;
  Press Ctrl-h to see the keyboard shortcuts
  &#10034;
  <a href='http://twitter.com/#!/netzpirat'>@netzpirat</a>
  &#10034;
  <a href='https://mksoft.ch'>mksoft.ch</a>
</div>
  </body>
</html>